StateFlow works using content equality to control conflation. If you set value of a MutableStateFlow to a new object that is equal to the existing value, the "new" value is not emitted to consumers.

In this example, our state is a State wrapper around an Int. State is a data class, so we get an equals() implementation that compares those Int values.

Initially, we populate our MutableStateFlow with State(123). We then update value with State(456) 25 times. We create new State objects for each of those passes, rather than reuse a single State. Yet, our collector will only receive the State(456) and the first of the State(123) states, not the remaining 24. Each of the latter 24 State(123) objects equals() the original one, so the collector is not given any of those 24.

You can learn more about this in:
Tags:
A Conflated Channel A Fixed-Buffer Channel A Parallel Coroutine Sample A Sequential Coroutine Sample A Simple Channel A Simple Coroutine Sample A Simple Flow A Simple SharedFlow A Simple StateFlow A Zero-Buffer Channel async() BroadcastChannel cancelAndJoin() Canceling a Job Canceling a Parent Cancels Its Children Canceling and Cooperation catch() Channel and receive() Channels and Fan-out combine() Operator Contexts and Jobs Cooperation by Checking isActive Cooperation by Yielding debounce() Operator distinctUntilChanged() Operator distinctUntilChangedBy() Operator drop() Operator dropWhile() Operator filter() Operator filterIsInstance() Operator filterNot() Operator filterNotNull() Operator first() and Flow flattenConcat() Operator flattenMerge() Operator Flow Actions Flow onStart() flowOf() flowOn() Flows and Exceptions fold() Operator Hot Channels Via offer() invokeOnCompletion() Jobs and Parents Jobs Cancel When They Crash join() Lazy Coroutines map() Operator mapLatest() Operator mapNotNull() Operator Massively Parallel Coroutines MutableSharedFlow Replay Option Non-Cancellable Coroutines Parent Jobs Cancel When a Child Crashes promise() retry() retryWhen() runBlocking() sample() Operator scan() Operator single() and singleOrNull() Starting Lazy Coroutines StateFlow and Content Equality suspend Functions and Flows Suspending main() take() Operator takeWhile() Operator The Channel() Function TimeoutCancellationException Timeouts toList() and toSet() toList() for Channel withIndex() Operator withTimeoutOrNull() zip() Operator
A Simple Flow A Simple SharedFlow A Simple StateFlow catch() combine() Operator debounce() Operator distinctUntilChanged() Operator distinctUntilChangedBy() Operator drop() Operator dropWhile() Operator filter() Operator filterIsInstance() Operator filterNot() Operator filterNotNull() Operator first() and Flow flattenConcat() Operator flattenMerge() Operator Flow Actions Flow onStart() flowOf() flowOn() Flows and Exceptions fold() Operator map() Operator mapLatest() Operator mapNotNull() Operator MutableSharedFlow Replay Option retry() retryWhen() sample() Operator scan() Operator single() and singleOrNull() StateFlow and Content Equality suspend Functions and Flows take() Operator takeWhile() Operator toList() and toSet() withIndex() Operator zip() Operator
Run Edit